<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>Column xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../apidocs/org/apache/torque/engine/database/model/Column.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <strong>package</strong> <a href="../../../../../../org/apache/torque/engine/database/model/package-summary.html">org.apache.torque.engine.database.model</a>;
<a name="2" href="#2">2</a>   
<a name="3" href="#3">3</a>   <em class="comment">/*</em>
<a name="4" href="#4">4</a>   <em class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
<a name="5" href="#5">5</a>   <em class="comment"> * or more contributor license agreements.  See the NOTICE file</em>
<a name="6" href="#6">6</a>   <em class="comment"> * distributed with this work for additional information</em>
<a name="7" href="#7">7</a>   <em class="comment"> * regarding copyright ownership.  The ASF licenses this file</em>
<a name="8" href="#8">8</a>   <em class="comment"> * to you under the Apache License, Version 2.0 (the</em>
<a name="9" href="#9">9</a>   <em class="comment"> * "License"); you may not use this file except in compliance</em>
<a name="10" href="#10">10</a>  <em class="comment"> * with the License.  You may obtain a copy of the License at</em>
<a name="11" href="#11">11</a>  <em class="comment"> *</em>
<a name="12" href="#12">12</a>  <em class="comment"> *   <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="13" href="#13">13</a>  <em class="comment"> *</em>
<a name="14" href="#14">14</a>  <em class="comment"> * Unless required by applicable law or agreed to in writing,</em>
<a name="15" href="#15">15</a>  <em class="comment"> * software distributed under the License is distributed on an</em>
<a name="16" href="#16">16</a>  <em class="comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
<a name="17" href="#17">17</a>  <em class="comment"> * KIND, either express or implied.  See the License for the</em>
<a name="18" href="#18">18</a>  <em class="comment"> * specific language governing permissions and limitations</em>
<a name="19" href="#19">19</a>  <em class="comment"> * under the License.</em>
<a name="20" href="#20">20</a>  <em class="comment"> */</em>
<a name="21" href="#21">21</a>  
<a name="22" href="#22">22</a>  <strong>import</strong> java.util.ArrayList;
<a name="23" href="#23">23</a>  <strong>import</strong> java.util.Collections;
<a name="24" href="#24">24</a>  <strong>import</strong> java.util.Iterator;
<a name="25" href="#25">25</a>  <strong>import</strong> java.util.List;
<a name="26" href="#26">26</a>  <strong>import</strong> java.util.Map;
<a name="27" href="#27">27</a>  
<a name="28" href="#28">28</a>  <strong>import</strong> org.apache.commons.collections.map.ListOrderedMap;
<a name="29" href="#29">29</a>  <strong>import</strong> org.apache.commons.lang.StringUtils;
<a name="30" href="#30">30</a>  <strong>import</strong> org.apache.commons.logging.Log;
<a name="31" href="#31">31</a>  <strong>import</strong> org.apache.commons.logging.LogFactory;
<a name="32" href="#32">32</a>  <strong>import</strong> org.apache.torque.engine.EngineException;
<a name="33" href="#33">33</a>  <strong>import</strong> org.apache.torque.engine.platform.Platform;
<a name="34" href="#34">34</a>  <strong>import</strong> org.apache.torque.engine.platform.PlatformDefaultImpl;
<a name="35" href="#35">35</a>  <strong>import</strong> org.xml.sax.Attributes;
<a name="36" href="#36">36</a>  
<a name="37" href="#37">37</a>  <em>/**<em>*</em></em>
<a name="38" href="#38">38</a>  <em> * A Class for holding data about a column used in an Application.</em>
<a name="39" href="#39">39</a>  <em> *</em>
<a name="40" href="#40">40</a>  <em> * @author &lt;a href="<a href="mailto:leon@opticode.co.za" target="alexandria_uri">mailto:leon@opticode.co.za</a>">Leon Messerschmidt&lt;/a></em>
<a name="41" href="#41">41</a>  <em> * @author &lt;a href="<a href="mailto:jvanzyl@apache.org" target="alexandria_uri">mailto:jvanzyl@apache.org</a>">Jason van Zyl&lt;/a></em>
<a name="42" href="#42">42</a>  <em> * @author &lt;a href="<a href="mailto:jon@latchkey.com" target="alexandria_uri">mailto:jon@latchkey.com</a>">Jon S. Stevens&lt;/a></em>
<a name="43" href="#43">43</a>  <em> * @author &lt;a href="<a href="mailto:dlr@finemaltcoding.com" target="alexandria_uri">mailto:dlr@finemaltcoding.com</a>">Daniel Rall&lt;/a></em>
<a name="44" href="#44">44</a>  <em> * @author &lt;a href="<a href="mailto:byron_foster@byron_foster@yahoo.com" target="alexandria_uri">mailto:byron_foster@byron_foster@yahoo.com</a>>Byron Foster&lt;/a></em>
<a name="45" href="#45">45</a>  <em> * @author &lt;a href="<a href="mailto:mpoeschl@marmot.at" target="alexandria_uri">mailto:mpoeschl@marmot.at</a>>Martin Poeschl&lt;/a></em>
<a name="46" href="#46">46</a>  <em> * @author &lt;a href="<a href="mailto:monroe@dukece.com" target="alexandria_uri">mailto:monroe@dukece.com</a>>Greg Monroe&lt;/a></em>
<a name="47" href="#47">47</a>  <em> * @version $Id: Column.java 476581 2006-11-18 18:14:14Z tv $</em>
<a name="48" href="#48">48</a>  <em> */</em>
<a name="49" href="#49">49</a>  <strong>public</strong> <strong>class</strong> <a href="../../../../../../org/apache/torque/engine/database/model/Column.html">Column</a>
<a name="50" href="#50">50</a>  {
<a name="51" href="#51">51</a>      <strong>private</strong> <strong>static</strong> <strong>final</strong> <a href="../../../../../../org/apache/torque/engine/database/model/SchemaType.html">SchemaType</a> DEFAULT_TYPE = SchemaType.VARCHAR;
<a name="52" href="#52">52</a>      <em>/**<em>* Logging class from commons.logging */</em></em>
<a name="53" href="#53">53</a>      <strong>private</strong> <strong>static</strong> Log log = LogFactory.getLog(Column.<strong>class</strong>);
<a name="54" href="#54">54</a>      <strong>private</strong> String name;
<a name="55" href="#55">55</a>      <strong>private</strong> String description;
<a name="56" href="#56">56</a>      <strong>private</strong> <a href="../../../../../../org/apache/torque/engine/database/model/Domain.html">Domain</a> domain = <strong>new</strong> <a href="../../../../../../org/apache/torque/engine/database/model/Domain.html">Domain</a>();
<a name="57" href="#57">57</a>      <strong>private</strong> String javaName = <strong>null</strong>;
<a name="58" href="#58">58</a>      <strong>private</strong> String javaNamingMethod;
<a name="59" href="#59">59</a>      <strong>private</strong> <strong>boolean</strong> isNotNull = false;
<a name="60" href="#60">60</a>      <strong>private</strong> <strong>boolean</strong> isProtected = false;
<a name="61" href="#61">61</a>      <strong>private</strong> String javaType;
<a name="62" href="#62">62</a>      <strong>private</strong> <a href="../../../../../../org/apache/torque/engine/database/model/Table.html">Table</a> parentTable;
<a name="63" href="#63">63</a>      <strong>private</strong> <strong>int</strong> position;
<a name="64" href="#64">64</a>      <strong>private</strong> <strong>boolean</strong> isPrimaryKey = false;
<a name="65" href="#65">65</a>      <strong>private</strong> <strong>boolean</strong> isUnique = false;
<a name="66" href="#66">66</a>      <strong>private</strong> <strong>boolean</strong> isAutoIncrement = false;
<a name="67" href="#67">67</a>      <strong>private</strong> List referrers;
<a name="68" href="#68">68</a>      <em class="comment">// only one type is supported currently, which assumes the</em>
<a name="69" href="#69">69</a>      <em class="comment">// column either contains the classnames or a key to</em>
<a name="70" href="#70">70</a>      <em class="comment">// classnames specified in the schema.  Others may be</em>
<a name="71" href="#71">71</a>      <em class="comment">// supported later.</em>
<a name="72" href="#72">72</a>      <strong>private</strong> String inheritanceType;
<a name="73" href="#73">73</a>      <strong>private</strong> <strong>boolean</strong> isInheritance;
<a name="74" href="#74">74</a>      <strong>private</strong> <strong>boolean</strong> isEnumeratedClasses;
<a name="75" href="#75">75</a>      <strong>private</strong> List inheritanceList;
<a name="76" href="#76">76</a>      <strong>private</strong> <strong>boolean</strong> needsTransactionInPostgres;
<a name="77" href="#77">77</a>  
<a name="78" href="#78">78</a>      <em>/**<em>* generate is... setters for boolean columns if true */</em></em>
<a name="79" href="#79">79</a>      <strong>private</strong> <strong>boolean</strong> correctGetters = false;
<a name="80" href="#80">80</a>  
<a name="81" href="#81">81</a>      <em>/**<em>* class name to do input validation on this column */</em></em>
<a name="82" href="#82">82</a>      <strong>private</strong> String inputValidator = <strong>null</strong>;
<a name="83" href="#83">83</a>      <strong>private</strong> Map options;
<a name="84" href="#84">84</a>  
<a name="85" href="#85">85</a>      <em>/**<em>*</em></em>
<a name="86" href="#86">86</a>  <em>     * Creates a new instance with a &lt;code>null&lt;/code> name.</em>
<a name="87" href="#87">87</a>  <em>     */</em>
<a name="88" href="#88">88</a>      <strong>public</strong> <a href="../../../../../../org/apache/torque/engine/database/model/Column.html">Column</a>()
<a name="89" href="#89">89</a>      {
<a name="90" href="#90">90</a>          <strong>this</strong>(<strong>null</strong>);
<a name="91" href="#91">91</a>      }
<a name="92" href="#92">92</a>  
<a name="93" href="#93">93</a>      <em>/**<em>*</em></em>
<a name="94" href="#94">94</a>  <em>     * Creates a new column and set the name</em>
<a name="95" href="#95">95</a>  <em>     *</em>
<a name="96" href="#96">96</a>  <em>     * @param name column name</em>
<a name="97" href="#97">97</a>  <em>     */</em>
<a name="98" href="#98">98</a>      <strong>public</strong> <a href="../../../../../../org/apache/torque/engine/database/model/Column.html">Column</a>(String name)
<a name="99" href="#99">99</a>      {
<a name="100" href="#100">100</a>         <strong>this</strong>.name = name;
<a name="101" href="#101">101</a>         options = Collections.synchronizedMap(<strong>new</strong> ListOrderedMap());
<a name="102" href="#102">102</a>     }
<a name="103" href="#103">103</a> 
<a name="104" href="#104">104</a>     <em>/**<em>*</em></em>
<a name="105" href="#105">105</a> <em>     * Return a comma delimited string listing the specified columns.</em>
<a name="106" href="#106">106</a> <em>     *</em>
<a name="107" href="#107">107</a> <em>     * @param columns Either a list of &lt;code>Column&lt;/code> objects, or</em>
<a name="108" href="#108">108</a> <em>     * a list of &lt;code>String&lt;/code> objects with column names.</em>
<a name="109" href="#109">109</a> <em>     */</em>
<a name="110" href="#110">110</a>     <strong>public</strong> <strong>static</strong> String makeList(List columns)
<a name="111" href="#111">111</a>     {
<a name="112" href="#112">112</a>         Object obj = columns.get(0);
<a name="113" href="#113">113</a>         <strong>boolean</strong> isColumnList = (obj instanceof Column);
<a name="114" href="#114">114</a>         <strong>if</strong> (isColumnList)
<a name="115" href="#115">115</a>         {
<a name="116" href="#116">116</a>             obj = ((Column) obj).getName();
<a name="117" href="#117">117</a>         }
<a name="118" href="#118">118</a>         StringBuffer buf = <strong>new</strong> StringBuffer((String) obj);
<a name="119" href="#119">119</a>         <strong>for</strong> (<strong>int</strong> i = 1; i &lt; columns.size(); i++)
<a name="120" href="#120">120</a>         {
<a name="121" href="#121">121</a>             obj = columns.get(i);
<a name="122" href="#122">122</a>             <strong>if</strong> (isColumnList)
<a name="123" href="#123">123</a>             {
<a name="124" href="#124">124</a>                 obj = ((Column) obj).getName();
<a name="125" href="#125">125</a>             }
<a name="126" href="#126">126</a>             buf.append(<span class="string">", "</span>).append(obj);
<a name="127" href="#127">127</a>         }
<a name="128" href="#128">128</a>         <strong>return</strong> buf.toString();
<a name="129" href="#129">129</a>     }
<a name="130" href="#130">130</a> 
<a name="131" href="#131">131</a>     <em>/**<em>*</em></em>
<a name="132" href="#132">132</a> <em>     * Imports a column from an XML specification</em>
<a name="133" href="#133">133</a> <em>     */</em>
<a name="134" href="#134">134</a>     <strong>public</strong> <strong>void</strong> loadFromXML(Attributes attrib)
<a name="135" href="#135">135</a>     {
<a name="136" href="#136">136</a>         String dom = attrib.getValue(<span class="string">"domain"</span>);
<a name="137" href="#137">137</a>         <strong>if</strong> (StringUtils.isNotEmpty(dom))
<a name="138" href="#138">138</a>         {
<a name="139" href="#139">139</a>             domain = <strong>new</strong> <a href="../../../../../../org/apache/torque/engine/database/model/Domain.html">Domain</a>(getTable().getDatabase().getDomain(dom));
<a name="140" href="#140">140</a>         }
<a name="141" href="#141">141</a>         <strong>else</strong>
<a name="142" href="#142">142</a>         {
<a name="143" href="#143">143</a>             domain = <strong>new</strong> <a href="../../../../../../org/apache/torque/engine/database/model/Domain.html">Domain</a>(getPlatform().getDomainForSchemaType(DEFAULT_TYPE));
<a name="144" href="#144">144</a>             setType(attrib.getValue(<span class="string">"type"</span>));
<a name="145" href="#145">145</a>         }
<a name="146" href="#146">146</a>         <em class="comment">//Name</em>
<a name="147" href="#147">147</a>         name = attrib.getValue(<span class="string">"name"</span>);
<a name="148" href="#148">148</a> 
<a name="149" href="#149">149</a>         javaName = attrib.getValue(<span class="string">"javaName"</span>);
<a name="150" href="#150">150</a>         javaType = attrib.getValue(<span class="string">"javaType"</span>);
<a name="151" href="#151">151</a>         <strong>if</strong> (javaType != <strong>null</strong> &amp;&amp; javaType.length() == 0)
<a name="152" href="#152">152</a>         {
<a name="153" href="#153">153</a>             javaType = <strong>null</strong>;
<a name="154" href="#154">154</a>         }
<a name="155" href="#155">155</a> 
<a name="156" href="#156">156</a>         <em class="comment">// retrieves the method for converting from specified name to</em>
<a name="157" href="#157">157</a>         <em class="comment">// a java name.</em>
<a name="158" href="#158">158</a>         javaNamingMethod = attrib.getValue(<span class="string">"javaNamingMethod"</span>);
<a name="159" href="#159">159</a>         <strong>if</strong> (javaNamingMethod == <strong>null</strong>)
<a name="160" href="#160">160</a>         {
<a name="161" href="#161">161</a>             javaNamingMethod
<a name="162" href="#162">162</a>                     = parentTable.getDatabase().getDefaultJavaNamingMethod();
<a name="163" href="#163">163</a>         }
<a name="164" href="#164">164</a> 
<a name="165" href="#165">165</a>         <em class="comment">//Primary Key</em>
<a name="166" href="#166">166</a>         String primaryKey = attrib.getValue(<span class="string">"primaryKey"</span>);
<a name="167" href="#167">167</a>         <em class="comment">//Avoid NullPointerExceptions on string comparisons.</em>
<a name="168" href="#168">168</a>         isPrimaryKey = (<span class="string">"true"</span>.equals(primaryKey));
<a name="169" href="#169">169</a> 
<a name="170" href="#170">170</a>         <em class="comment">// If this column is a primary key then it can't be null.</em>
<a name="171" href="#171">171</a>         <strong>if</strong> (<span class="string">"true"</span>.equals(primaryKey))
<a name="172" href="#172">172</a>         {
<a name="173" href="#173">173</a>             isNotNull = <strong>true</strong>;
<a name="174" href="#174">174</a>         }
<a name="175" href="#175">175</a> 
<a name="176" href="#176">176</a>         <em class="comment">// HELP: Should primary key, index, and/or idMethod="native"</em>
<a name="177" href="#177">177</a>         <em class="comment">// affect isNotNull?  If not, please document why here.</em>
<a name="178" href="#178">178</a>         String notNull = attrib.getValue(<span class="string">"required"</span>);
<a name="179" href="#179">179</a>         isNotNull = (notNull != <strong>null</strong> &amp;&amp; <span class="string">"true"</span>.equals(notNull));
<a name="180" href="#180">180</a> 
<a name="181" href="#181">181</a>         <em class="comment">//AutoIncrement/Sequences</em>
<a name="182" href="#182">182</a>         String autoIncrement = attrib.getValue(<span class="string">"autoIncrement"</span>);
<a name="183" href="#183">183</a>         <em class="comment">// autoincrement is false per default,</em>
<a name="184" href="#184">184</a>         <em class="comment">// except if the column is a primary key</em>
<a name="185" href="#185">185</a>         <em class="comment">// and the idMethod is native</em>
<a name="186" href="#186">186</a>         <em class="comment">// and the platform's default id Method is identity</em>
<a name="187" href="#187">187</a>         <em class="comment">// and autoIncrement is not excplicitly set to false</em>
<a name="188" href="#188">188</a>         isAutoIncrement = (<span class="string">"true"</span>.equals(autoIncrement)
<a name="189" href="#189">189</a>                 || (isPrimaryKey()
<a name="190" href="#190">190</a>                     &amp;&amp; IDMethod.NATIVE.equals(getTable().getIdMethod())
<a name="191" href="#191">191</a>                     &amp;&amp; Platform.IDENTITY.equals(
<a name="192" href="#192">192</a>                             getPlatform().getNativeIdMethod())
<a name="193" href="#193">193</a>                     &amp;&amp; (!<span class="string">"false"</span>.equals(autoIncrement))));
<a name="194" href="#194">194</a>         <em class="comment">//Default column value.</em>
<a name="195" href="#195">195</a>         domain.replaceDefaultValue(attrib.getValue(<span class="string">"default"</span>));
<a name="196" href="#196">196</a> 
<a name="197" href="#197">197</a>         domain.replaceSize(attrib.getValue(<span class="string">"size"</span>));
<a name="198" href="#198">198</a>         domain.replaceScale(attrib.getValue(<span class="string">"scale"</span>));
<a name="199" href="#199">199</a> 
<a name="200" href="#200">200</a>         inheritanceType = attrib.getValue(<span class="string">"inheritance"</span>);
<a name="201" href="#201">201</a>         isInheritance = (inheritanceType != <strong>null</strong>
<a name="202" href="#202">202</a>                 &amp;&amp; !inheritanceType.equals(<span class="string">"false"</span>));
<a name="203" href="#203">203</a> 
<a name="204" href="#204">204</a>         <strong>this</strong>.inputValidator = attrib.getValue(<span class="string">"inputValidator"</span>);
<a name="205" href="#205">205</a>         description = attrib.getValue(<span class="string">"description"</span>);
<a name="206" href="#206">206</a> 
<a name="207" href="#207">207</a>         isProtected = (<span class="string">"true"</span>.equals(attrib.getValue(<span class="string">"protected"</span>)));
<a name="208" href="#208">208</a>     }
<a name="209" href="#209">209</a> 
<a name="210" href="#210">210</a>     <em>/**<em>*</em></em>
<a name="211" href="#211">211</a> <em>     * Returns table.column</em>
<a name="212" href="#212">212</a> <em>     */</em>
<a name="213" href="#213">213</a>     <strong>public</strong> String getFullyQualifiedName()
<a name="214" href="#214">214</a>     {
<a name="215" href="#215">215</a>         <strong>return</strong> (parentTable.getName() + '.' + name);
<a name="216" href="#216">216</a>     }
<a name="217" href="#217">217</a> 
<a name="218" href="#218">218</a>     <em>/**<em>*</em></em>
<a name="219" href="#219">219</a> <em>     * Get the name of the column</em>
<a name="220" href="#220">220</a> <em>     */</em>
<a name="221" href="#221">221</a>     <strong>public</strong> String getName()
<a name="222" href="#222">222</a>     {
<a name="223" href="#223">223</a>         <strong>return</strong> name;
<a name="224" href="#224">224</a>     }
<a name="225" href="#225">225</a> 
<a name="226" href="#226">226</a>     <em>/**<em>*</em></em>
<a name="227" href="#227">227</a> <em>     * Set the name of the column</em>
<a name="228" href="#228">228</a> <em>     */</em>
<a name="229" href="#229">229</a>     <strong>public</strong> <strong>void</strong> setName(String newName)
<a name="230" href="#230">230</a>     {
<a name="231" href="#231">231</a>         name = newName;
<a name="232" href="#232">232</a>     }
<a name="233" href="#233">233</a> 
<a name="234" href="#234">234</a>     <em>/**<em>*</em></em>
<a name="235" href="#235">235</a> <em>     * Get the description for the Table</em>
<a name="236" href="#236">236</a> <em>     */</em>
<a name="237" href="#237">237</a>     <strong>public</strong> String getDescription()
<a name="238" href="#238">238</a>     {
<a name="239" href="#239">239</a>         <strong>return</strong> description;
<a name="240" href="#240">240</a>     }
<a name="241" href="#241">241</a> 
<a name="242" href="#242">242</a>     <em>/**<em>*</em></em>
<a name="243" href="#243">243</a> <em>     * Set the description for the Table</em>
<a name="244" href="#244">244</a> <em>     *</em>
<a name="245" href="#245">245</a> <em>     * @param newDescription description for the Table</em>
<a name="246" href="#246">246</a> <em>     */</em>
<a name="247" href="#247">247</a>     <strong>public</strong> <strong>void</strong> setDescription(String newDescription)
<a name="248" href="#248">248</a>     {
<a name="249" href="#249">249</a>         description = newDescription;
<a name="250" href="#250">250</a>     }
<a name="251" href="#251">251</a> 
<a name="252" href="#252">252</a>     <em>/**<em>*</em></em>
<a name="253" href="#253">253</a> <em>     * Get name to use in Java sources to build method names.</em>
<a name="254" href="#254">254</a> <em>     *</em>
<a name="255" href="#255">255</a> <em>     * @return the capitalised javaName</em>
<a name="256" href="#256">256</a> <em>     */</em>
<a name="257" href="#257">257</a>     <strong>public</strong> String getJavaName()
<a name="258" href="#258">258</a>     {
<a name="259" href="#259">259</a>         <strong>if</strong> (javaName == <strong>null</strong>)
<a name="260" href="#260">260</a>         {
<a name="261" href="#261">261</a>             List inputs = <strong>new</strong> ArrayList(2);
<a name="262" href="#262">262</a>             inputs.add(name);
<a name="263" href="#263">263</a>             inputs.add(javaNamingMethod);
<a name="264" href="#264">264</a>             <strong>try</strong>
<a name="265" href="#265">265</a>             {
<a name="266" href="#266">266</a>                 javaName = NameFactory.generateName(NameFactory.JAVA_GENERATOR,
<a name="267" href="#267">267</a>                                                     inputs);
<a name="268" href="#268">268</a>             }
<a name="269" href="#269">269</a>             <strong>catch</strong> (EngineException e)
<a name="270" href="#270">270</a>             {
<a name="271" href="#271">271</a>                 log.error(e, e);
<a name="272" href="#272">272</a>             }
<a name="273" href="#273">273</a>         }
<a name="274" href="#274">274</a>         <strong>return</strong> StringUtils.capitalize(javaName);
<a name="275" href="#275">275</a>     }
<a name="276" href="#276">276</a> 
<a name="277" href="#277">277</a>     <em>/**<em>*</em></em>
<a name="278" href="#278">278</a> <em>     * Returns the name for the getter method to retrieve the value of this</em>
<a name="279" href="#279">279</a> <em>     * column</em>
<a name="280" href="#280">280</a> <em>     *</em>
<a name="281" href="#281">281</a> <em>     * @return A getter method name for this column.</em>
<a name="282" href="#282">282</a> <em>     * @since 3.2</em>
<a name="283" href="#283">283</a> <em>     */</em>
<a name="284" href="#284">284</a>     <strong>public</strong> String getGetterName()
<a name="285" href="#285">285</a>     {
<a name="286" href="#286">286</a>         <strong>if</strong> ((<span class="string">"boolean"</span>.equalsIgnoreCase(getJavaNative()) &amp;&amp; isCorrectGetters()))
<a name="287" href="#287">287</a>         {
<a name="288" href="#288">288</a>             <strong>return</strong> <span class="string">"is"</span> + StringUtils.capitalize(getJavaName());
<a name="289" href="#289">289</a>         }
<a name="290" href="#290">290</a>         <strong>else</strong>
<a name="291" href="#291">291</a>         {
<a name="292" href="#292">292</a>             <strong>return</strong> <span class="string">"get"</span> + StringUtils.capitalize(getJavaName());
<a name="293" href="#293">293</a>         }
<a name="294" href="#294">294</a>     }
<a name="295" href="#295">295</a> 
<a name="296" href="#296">296</a>     <em>/**<em>*</em></em>
<a name="297" href="#297">297</a> <em>     * Returns the name for the setter method to set the value of this</em>
<a name="298" href="#298">298</a> <em>     * column</em>
<a name="299" href="#299">299</a> <em>     *</em>
<a name="300" href="#300">300</a> <em>     * @return A setter method name for this column.</em>
<a name="301" href="#301">301</a> <em>     * @since 3.2</em>
<a name="302" href="#302">302</a> <em>     */</em>
<a name="303" href="#303">303</a>     <strong>public</strong> String getSetterName()
<a name="304" href="#304">304</a>     {
<a name="305" href="#305">305</a>         <strong>return</strong> <span class="string">"set"</span> + StringUtils.capitalize(getJavaName());
<a name="306" href="#306">306</a>     }
<a name="307" href="#307">307</a> 
<a name="308" href="#308">308</a>     <em>/**<em>*</em></em>
<a name="309" href="#309">309</a> <em>     * Get variable name to use in Java sources (= uncapitalised java name)</em>
<a name="310" href="#310">310</a> <em>     */</em>
<a name="311" href="#311">311</a>     <strong>public</strong> String getUncapitalisedJavaName()
<a name="312" href="#312">312</a>     {
<a name="313" href="#313">313</a>         <strong>return</strong> StringUtils.uncapitalize(getJavaName());
<a name="314" href="#314">314</a>     }
<a name="315" href="#315">315</a> 
<a name="316" href="#316">316</a>     <em>/**<em>*</em></em>
<a name="317" href="#317">317</a> <em>     * Returns the name of the constant that is used for the column in the Peer</em>
<a name="318" href="#318">318</a> <em>     * class, e.g., RecordPeer.COLVARNAME.</em>
<a name="319" href="#319">319</a> <em>     * Generally this will be a straight conversion to upper case.</em>
<a name="320" href="#320">320</a> <em>     * But if the column name is equals to TABLE_NAME or</em>
<a name="321" href="#321">321</a> <em>     * DATABASE_NAME (Torque predefined vars), the column name will have an _</em>
<a name="322" href="#322">322</a> <em>     * prefixed, e.g. _TABLE_NAME.</em>
<a name="323" href="#323">323</a> <em>     * &lt;p></em>
<a name="324" href="#324">324</a> <em>     * TODO: Handle delimited column names that have non-Java identifier</em>
<a name="325" href="#325">325</a> <em>     * characters in them.</em>
<a name="326" href="#326">326</a> <em>     *</em>
<a name="327" href="#327">327</a> <em>     * @return The name to use in defining the Peer class column variable.</em>
<a name="328" href="#328">328</a> <em>     */</em>
<a name="329" href="#329">329</a>     <strong>public</strong> String getPeerJavaName()
<a name="330" href="#330">330</a>     {
<a name="331" href="#331">331</a>         String peerName = name.toUpperCase();
<a name="332" href="#332">332</a>         <strong>if</strong> ( peerName.equals(<span class="string">"TABLE_NAME"</span>) ||
<a name="333" href="#333">333</a>              peerName.equals(<span class="string">"DATABASE_NAME"</span>)) {
<a name="334" href="#334">334</a>             peerName = <span class="string">"_"</span> + peerName;
<a name="335" href="#335">335</a>         }
<a name="336" href="#336">336</a>         <strong>return</strong> peerName;
<a name="337" href="#337">337</a>     }
<a name="338" href="#338">338</a> 
<a name="339" href="#339">339</a>     <em>/**<em>*</em></em>
<a name="340" href="#340">340</a> <em>     * Set the name to use in Java sources.</em>
<a name="341" href="#341">341</a> <em>     */</em>
<a name="342" href="#342">342</a>     <strong>public</strong> <strong>void</strong> setJavaName(String javaName)
<a name="343" href="#343">343</a>     {
<a name="344" href="#344">344</a>         <strong>this</strong>.javaName = javaName;
<a name="345" href="#345">345</a>     }
<a name="346" href="#346">346</a> 
<a name="347" href="#347">347</a>     <em>/**<em>*</em></em>
<a name="348" href="#348">348</a> <em>     * Returns whether the type in the java object should be an object</em>
<a name="349" href="#349">349</a> <em>     * or primitive.</em>
<a name="350" href="#350">350</a> <em>     */</em>
<a name="351" href="#351">351</a>     <strong>public</strong> String getJavaType()
<a name="352" href="#352">352</a>     {
<a name="353" href="#353">353</a>         <strong>return</strong> javaType;
<a name="354" href="#354">354</a>     }
<a name="355" href="#355">355</a> 
<a name="356" href="#356">356</a>     <em>/**<em>*</em></em>
<a name="357" href="#357">357</a> <em>     * Get the location of this column within the table (one-based).</em>
<a name="358" href="#358">358</a> <em>     * @return value of position.</em>
<a name="359" href="#359">359</a> <em>     */</em>
<a name="360" href="#360">360</a>     <strong>public</strong> <strong>int</strong> getPosition()
<a name="361" href="#361">361</a>     {
<a name="362" href="#362">362</a>         <strong>return</strong> position;
<a name="363" href="#363">363</a>     }
<a name="364" href="#364">364</a> 
<a name="365" href="#365">365</a>     <em>/**<em>*</em></em>
<a name="366" href="#366">366</a> <em>     * Get the location of this column within the table (one-based).</em>
<a name="367" href="#367">367</a> <em>     * @param v  Value to assign to position.</em>
<a name="368" href="#368">368</a> <em>     */</em>
<a name="369" href="#369">369</a>     <strong>public</strong> <strong>void</strong> setPosition(<strong>int</strong>  v)
<a name="370" href="#370">370</a>     {
<a name="371" href="#371">371</a>         <strong>this</strong>.position = v;
<a name="372" href="#372">372</a>     }
<a name="373" href="#373">373</a> 
<a name="374" href="#374">374</a>     <em>/**<em>*</em></em>
<a name="375" href="#375">375</a> <em>     * Set the parent Table of the column</em>
<a name="376" href="#376">376</a> <em>     */</em>
<a name="377" href="#377">377</a>     <strong>public</strong> <strong>void</strong> setTable(<a href="../../../../../../org/apache/torque/engine/database/model/Table.html">Table</a> parent)
<a name="378" href="#378">378</a>     {
<a name="379" href="#379">379</a>         parentTable = parent;
<a name="380" href="#380">380</a>     }
<a name="381" href="#381">381</a> 
<a name="382" href="#382">382</a>     <em>/**<em>*</em></em>
<a name="383" href="#383">383</a> <em>     * Get the parent Table of the column</em>
<a name="384" href="#384">384</a> <em>     */</em>
<a name="385" href="#385">385</a>     <strong>public</strong> <a href="../../../../../../org/apache/torque/engine/database/model/Table.html">Table</a> getTable()
<a name="386" href="#386">386</a>     {
<a name="387" href="#387">387</a>         <strong>return</strong> parentTable;
<a name="388" href="#388">388</a>     }
<a name="389" href="#389">389</a> 
<a name="390" href="#390">390</a>     <em>/**<em>*</em></em>
<a name="391" href="#391">391</a> <em>     * Returns the Name of the table the column is in</em>
<a name="392" href="#392">392</a> <em>     */</em>
<a name="393" href="#393">393</a>     <strong>public</strong> String getTableName()
<a name="394" href="#394">394</a>     {
<a name="395" href="#395">395</a>         <strong>return</strong> parentTable.getName();
<a name="396" href="#396">396</a>     }
<a name="397" href="#397">397</a> 
<a name="398" href="#398">398</a>     <em>/**<em>*</em></em>
<a name="399" href="#399">399</a> <em>     * A utility function to create a new column</em>
<a name="400" href="#400">400</a> <em>     * from attrib and add it to this table.</em>
<a name="401" href="#401">401</a> <em>     */</em>
<a name="402" href="#402">402</a>     <strong>public</strong> <a href="../../../../../../org/apache/torque/engine/database/model/Inheritance.html">Inheritance</a> addInheritance(Attributes attrib)
<a name="403" href="#403">403</a>     {
<a name="404" href="#404">404</a>         <a href="../../../../../../org/apache/torque/engine/database/model/Inheritance.html">Inheritance</a> inh = <strong>new</strong> <a href="../../../../../../org/apache/torque/engine/database/model/Inheritance.html">Inheritance</a>();
<a name="405" href="#405">405</a>         inh.loadFromXML (attrib);
<a name="406" href="#406">406</a>         addInheritance(inh);
<a name="407" href="#407">407</a> 
<a name="408" href="#408">408</a>         <strong>return</strong> inh;
<a name="409" href="#409">409</a>     }
<a name="410" href="#410">410</a> 
<a name="411" href="#411">411</a>     <em>/**<em>*</em></em>
<a name="412" href="#412">412</a> <em>     * Adds a new inheritance definition to the inheritance list and set the</em>
<a name="413" href="#413">413</a> <em>     * parent column of the inheritance to the current column</em>
<a name="414" href="#414">414</a> <em>     */</em>
<a name="415" href="#415">415</a>     <strong>public</strong> <strong>void</strong> addInheritance(<a href="../../../../../../org/apache/torque/engine/database/model/Inheritance.html">Inheritance</a> inh)
<a name="416" href="#416">416</a>     {
<a name="417" href="#417">417</a>         inh.setColumn(<strong>this</strong>);
<a name="418" href="#418">418</a>         <strong>if</strong> (inheritanceList == <strong>null</strong>)
<a name="419" href="#419">419</a>         {
<a name="420" href="#420">420</a>             inheritanceList = <strong>new</strong> ArrayList();
<a name="421" href="#421">421</a>             isEnumeratedClasses = <strong>true</strong>;
<a name="422" href="#422">422</a>         }
<a name="423" href="#423">423</a>         inheritanceList.add(inh);
<a name="424" href="#424">424</a>     }
<a name="425" href="#425">425</a> 
<a name="426" href="#426">426</a>     <em>/**<em>*</em></em>
<a name="427" href="#427">427</a> <em>     * Get the inheritance definitions.</em>
<a name="428" href="#428">428</a> <em>     */</em>
<a name="429" href="#429">429</a>     <strong>public</strong> List getChildren()
<a name="430" href="#430">430</a>     {
<a name="431" href="#431">431</a>         <strong>return</strong> inheritanceList;
<a name="432" href="#432">432</a>     }
<a name="433" href="#433">433</a> 
<a name="434" href="#434">434</a>     <em>/**<em>*</em></em>
<a name="435" href="#435">435</a> <em>     * Determine if this column is a normal property or specifies a</em>
<a name="436" href="#436">436</a> <em>     * the classes that are represented in the table containing this column.</em>
<a name="437" href="#437">437</a> <em>     */</em>
<a name="438" href="#438">438</a>     <strong>public</strong> <strong>boolean</strong> isInheritance()
<a name="439" href="#439">439</a>     {
<a name="440" href="#440">440</a>         <strong>return</strong> isInheritance;
<a name="441" href="#441">441</a>     }
<a name="442" href="#442">442</a> 
<a name="443" href="#443">443</a>     <em>/**<em>*</em></em>
<a name="444" href="#444">444</a> <em>     * Determine if possible classes have been enumerated in the xml file.</em>
<a name="445" href="#445">445</a> <em>     */</em>
<a name="446" href="#446">446</a>     <strong>public</strong> <strong>boolean</strong> isEnumeratedClasses()
<a name="447" href="#447">447</a>     {
<a name="448" href="#448">448</a>         <strong>return</strong> isEnumeratedClasses;
<a name="449" href="#449">449</a>     }
<a name="450" href="#450">450</a> 
<a name="451" href="#451">451</a>     <em>/**<em>*</em></em>
<a name="452" href="#452">452</a> <em>     * Return the isNotNull property of the column</em>
<a name="453" href="#453">453</a> <em>     */</em>
<a name="454" href="#454">454</a>     <strong>public</strong> <strong>boolean</strong> isNotNull()
<a name="455" href="#455">455</a>     {
<a name="456" href="#456">456</a>         <strong>return</strong> isNotNull;
<a name="457" href="#457">457</a>     }
<a name="458" href="#458">458</a> 
<a name="459" href="#459">459</a>     <em>/**<em>*</em></em>
<a name="460" href="#460">460</a> <em>     * Set the isNotNull property of the column</em>
<a name="461" href="#461">461</a> <em>     */</em>
<a name="462" href="#462">462</a>     <strong>public</strong> <strong>void</strong> setNotNull(<strong>boolean</strong> status)
<a name="463" href="#463">463</a>     {
<a name="464" href="#464">464</a>         isNotNull = status;
<a name="465" href="#465">465</a>     }
<a name="466" href="#466">466</a> 
<a name="467" href="#467">467</a>     <em>/**<em>*</em></em>
<a name="468" href="#468">468</a> <em>     * Return NOT NULL String for this column</em>
<a name="469" href="#469">469</a> <em>     *</em>
<a name="470" href="#470">470</a> <em>     * @return "NOT NULL" if null values are not allowed or an empty String.</em>
<a name="471" href="#471">471</a> <em>     */</em>
<a name="472" href="#472">472</a>     <strong>public</strong> String getNotNullString()
<a name="473" href="#473">473</a>     {
<a name="474" href="#474">474</a>         <strong>return</strong> getTable().getDatabase().getPlatform()
<a name="475" href="#475">475</a>                 .getNullString(<strong>this</strong>.isNotNull());
<a name="476" href="#476">476</a>     }
<a name="477" href="#477">477</a> 
<a name="478" href="#478">478</a>     <em>/**<em>*</em></em>
<a name="479" href="#479">479</a> <em>     * Return the isProtected property of the column</em>
<a name="480" href="#480">480</a> <em>     */</em>
<a name="481" href="#481">481</a>     <strong>public</strong> <strong>boolean</strong> isProtected()
<a name="482" href="#482">482</a>     {
<a name="483" href="#483">483</a>         <strong>return</strong> isProtected;
<a name="484" href="#484">484</a>     }
<a name="485" href="#485">485</a> 
<a name="486" href="#486">486</a>     <em>/**<em>*</em></em>
<a name="487" href="#487">487</a> <em>     * Set the isProtected property of the Column</em>
<a name="488" href="#488">488</a> <em>     */</em>
<a name="489" href="#489">489</a>     <strong>public</strong> <strong>void</strong> setProtected(<strong>boolean</strong> prot)
<a name="490" href="#490">490</a>     {
<a name="491" href="#491">491</a>         isProtected = prot;
<a name="492" href="#492">492</a>     }
<a name="493" href="#493">493</a> 
<a name="494" href="#494">494</a>     <em>/**<em>*</em></em>
<a name="495" href="#495">495</a> <em>     * Set if the column is a primary key or not</em>
<a name="496" href="#496">496</a> <em>     */</em>
<a name="497" href="#497">497</a>     <strong>public</strong> <strong>void</strong> setPrimaryKey(<strong>boolean</strong> pk)
<a name="498" href="#498">498</a>     {
<a name="499" href="#499">499</a>         isPrimaryKey = pk;
<a name="500" href="#500">500</a>     }
<a name="501" href="#501">501</a> 
<a name="502" href="#502">502</a>     <em>/**<em>*</em></em>
<a name="503" href="#503">503</a> <em>     * Return true if the column is a primary key</em>
<a name="504" href="#504">504</a> <em>     */</em>
<a name="505" href="#505">505</a>     <strong>public</strong> <strong>boolean</strong> isPrimaryKey()
<a name="506" href="#506">506</a>     {
<a name="507" href="#507">507</a>         <strong>return</strong> isPrimaryKey;
<a name="508" href="#508">508</a>     }
<a name="509" href="#509">509</a> 
<a name="510" href="#510">510</a>     <em>/**<em>*</em></em>
<a name="511" href="#511">511</a> <em>     * Set true if the column is UNIQUE</em>
<a name="512" href="#512">512</a> <em>     */</em>
<a name="513" href="#513">513</a>     <strong>public</strong> <strong>void</strong> setUnique (<strong>boolean</strong> u)
<a name="514" href="#514">514</a>     {
<a name="515" href="#515">515</a>         isUnique = u;
<a name="516" href="#516">516</a>     }
<a name="517" href="#517">517</a> 
<a name="518" href="#518">518</a>     <em>/**<em>*</em></em>
<a name="519" href="#519">519</a> <em>     * Get the UNIQUE property</em>
<a name="520" href="#520">520</a> <em>     */</em>
<a name="521" href="#521">521</a>     <strong>public</strong> <strong>boolean</strong> isUnique()
<a name="522" href="#522">522</a>     {
<a name="523" href="#523">523</a>         <strong>return</strong> isUnique;
<a name="524" href="#524">524</a>     }
<a name="525" href="#525">525</a> 
<a name="526" href="#526">526</a>     <em>/**<em>*</em></em>
<a name="527" href="#527">527</a> <em>     * Return true if the column requires a transaction in Postgres</em>
<a name="528" href="#528">528</a> <em>     */</em>
<a name="529" href="#529">529</a>     <strong>public</strong> <strong>boolean</strong> requiresTransactionInPostgres()
<a name="530" href="#530">530</a>     {
<a name="531" href="#531">531</a>         <strong>return</strong> needsTransactionInPostgres;
<a name="532" href="#532">532</a>     }
<a name="533" href="#533">533</a> 
<a name="534" href="#534">534</a>     <em>/**<em>*</em></em>
<a name="535" href="#535">535</a> <em>     * Utility method to determine if this column is a foreign key.</em>
<a name="536" href="#536">536</a> <em>     */</em>
<a name="537" href="#537">537</a>     <strong>public</strong> <strong>boolean</strong> isForeignKey()
<a name="538" href="#538">538</a>     {
<a name="539" href="#539">539</a>         <strong>return</strong> (getForeignKey() != <strong>null</strong>);
<a name="540" href="#540">540</a>     }
<a name="541" href="#541">541</a> 
<a name="542" href="#542">542</a>     <em>/**<em>*</em></em>
<a name="543" href="#543">543</a> <em>     * Determine if this column is a foreign key that refers to the</em>
<a name="544" href="#544">544</a> <em>     * same table as another foreign key column in this table.</em>
<a name="545" href="#545">545</a> <em>     */</em>
<a name="546" href="#546">546</a>     <strong>public</strong> <strong>boolean</strong> isMultipleFK()
<a name="547" href="#547">547</a>     {
<a name="548" href="#548">548</a>         <a href="../../../../../../org/apache/torque/engine/database/model/ForeignKey.html">ForeignKey</a> fk = getForeignKey();
<a name="549" href="#549">549</a>         <strong>if</strong> (fk != <strong>null</strong>)
<a name="550" href="#550">550</a>         {
<a name="551" href="#551">551</a>             Iterator fks = parentTable.getForeignKeys().iterator();
<a name="552" href="#552">552</a>             <strong>while</strong> (fks.hasNext())
<a name="553" href="#553">553</a>             {
<a name="554" href="#554">554</a>                 <a href="../../../../../../org/apache/torque/engine/database/model/ForeignKey.html">ForeignKey</a> key = (ForeignKey) fks.next();
<a name="555" href="#555">555</a>                 <strong>if</strong> (key.getForeignTableName().equals(fk.getForeignTableName())
<a name="556" href="#556">556</a>                         &amp;&amp; !key.getLocalColumns().contains(<strong>this</strong>.name))
<a name="557" href="#557">557</a>                 {
<a name="558" href="#558">558</a>                     <strong>return</strong> <strong>true</strong>;
<a name="559" href="#559">559</a>                 }
<a name="560" href="#560">560</a>             }
<a name="561" href="#561">561</a>         }
<a name="562" href="#562">562</a> 
<a name="563" href="#563">563</a>         <em class="comment">// No multiple foreign keys.</em>
<a name="564" href="#564">564</a>         <strong>return</strong> false;
<a name="565" href="#565">565</a>     }
<a name="566" href="#566">566</a> 
<a name="567" href="#567">567</a>     <em>/**<em>*</em></em>
<a name="568" href="#568">568</a> <em>     * get the foreign key object for this column</em>
<a name="569" href="#569">569</a> <em>     * if it is a foreign key or part of a foreign key</em>
<a name="570" href="#570">570</a> <em>     */</em>
<a name="571" href="#571">571</a>     <strong>public</strong> <a href="../../../../../../org/apache/torque/engine/database/model/ForeignKey.html">ForeignKey</a> getForeignKey()
<a name="572" href="#572">572</a>     {
<a name="573" href="#573">573</a>         <strong>return</strong> parentTable.getForeignKey(<strong>this</strong>.name);
<a name="574" href="#574">574</a>     }
<a name="575" href="#575">575</a> 
<a name="576" href="#576">576</a>     <em>/**<em>*</em></em>
<a name="577" href="#577">577</a> <em>     * Utility method to get the related table of this column if it is a foreign</em>
<a name="578" href="#578">578</a> <em>     * key or part of a foreign key</em>
<a name="579" href="#579">579</a> <em>     */</em>
<a name="580" href="#580">580</a>     <strong>public</strong> String getRelatedTableName()
<a name="581" href="#581">581</a>     {
<a name="582" href="#582">582</a>         <a href="../../../../../../org/apache/torque/engine/database/model/ForeignKey.html">ForeignKey</a> fk = getForeignKey();
<a name="583" href="#583">583</a>         <strong>return</strong> (fk == <strong>null</strong> ? <strong>null</strong> : fk.getForeignTableName());
<a name="584" href="#584">584</a>     }
<a name="585" href="#585">585</a> 
<a name="586" href="#586">586</a>     <em>/**<em>*</em></em>
<a name="587" href="#587">587</a> <em>     * Utility method to get the related column of this local column if this</em>
<a name="588" href="#588">588</a> <em>     * column is a foreign key or part of a foreign key.</em>
<a name="589" href="#589">589</a> <em>     */</em>
<a name="590" href="#590">590</a>     <strong>public</strong> String getRelatedColumnName()
<a name="591" href="#591">591</a>     {
<a name="592" href="#592">592</a>         <a href="../../../../../../org/apache/torque/engine/database/model/ForeignKey.html">ForeignKey</a> fk = getForeignKey();
<a name="593" href="#593">593</a>         <strong>if</strong> (fk == <strong>null</strong>)
<a name="594" href="#594">594</a>         {
<a name="595" href="#595">595</a>             <strong>return</strong> <strong>null</strong>;
<a name="596" href="#596">596</a>         }
<a name="597" href="#597">597</a>         <strong>else</strong>
<a name="598" href="#598">598</a>         {
<a name="599" href="#599">599</a>             <strong>return</strong> fk.getLocalForeignMapping().get(<strong>this</strong>.name).toString();
<a name="600" href="#600">600</a>         }
<a name="601" href="#601">601</a>     }
<a name="602" href="#602">602</a> 
<a name="603" href="#603">603</a>     <em>/**<em>*</em></em>
<a name="604" href="#604">604</a> <em>     * Adds the foreign key from another table that refers to this column.</em>
<a name="605" href="#605">605</a> <em>     */</em>
<a name="606" href="#606">606</a>     <strong>public</strong> <strong>void</strong> addReferrer(<a href="../../../../../../org/apache/torque/engine/database/model/ForeignKey.html">ForeignKey</a> fk)
<a name="607" href="#607">607</a>     {
<a name="608" href="#608">608</a>         <strong>if</strong> (referrers == <strong>null</strong>)
<a name="609" href="#609">609</a>         {
<a name="610" href="#610">610</a>             referrers = <strong>new</strong> ArrayList(5);
<a name="611" href="#611">611</a>         }
<a name="612" href="#612">612</a>         referrers.add(fk);
<a name="613" href="#613">613</a>     }
<a name="614" href="#614">614</a> 
<a name="615" href="#615">615</a>     <em>/**<em>*</em></em>
<a name="616" href="#616">616</a> <em>     * Get list of references to this column.</em>
<a name="617" href="#617">617</a> <em>     */</em>
<a name="618" href="#618">618</a>     <strong>public</strong> List getReferrers()
<a name="619" href="#619">619</a>     {
<a name="620" href="#620">620</a>         <strong>if</strong> (referrers == <strong>null</strong>)
<a name="621" href="#621">621</a>         {
<a name="622" href="#622">622</a>             referrers = <strong>new</strong> ArrayList(5);
<a name="623" href="#623">623</a>         }
<a name="624" href="#624">624</a>         <strong>return</strong> referrers;
<a name="625" href="#625">625</a>     }
<a name="626" href="#626">626</a> 
<a name="627" href="#627">627</a>     <em>/**<em>*</em></em>
<a name="628" href="#628">628</a> <em>     * Sets the colunm type</em>
<a name="629" href="#629">629</a> <em>     */</em>
<a name="630" href="#630">630</a>     <strong>public</strong> <strong>void</strong> setType(String torqueType)
<a name="631" href="#631">631</a>     {
<a name="632" href="#632">632</a>         <a href="../../../../../../org/apache/torque/engine/database/model/SchemaType.html">SchemaType</a> type = SchemaType.getEnum(torqueType);
<a name="633" href="#633">633</a>         <strong>if</strong> (type == <strong>null</strong>)
<a name="634" href="#634">634</a>         {
<a name="635" href="#635">635</a>             log.warn(<span class="string">"SchemaType "</span> + torqueType + <span class="string">" does not exist"</span>);
<a name="636" href="#636">636</a>             type = Column.DEFAULT_TYPE;
<a name="637" href="#637">637</a>         }
<a name="638" href="#638">638</a>         setType(type);
<a name="639" href="#639">639</a>     }
<a name="640" href="#640">640</a> 
<a name="641" href="#641">641</a>     <em>/**<em>*</em></em>
<a name="642" href="#642">642</a> <em>     * Sets the colunm type</em>
<a name="643" href="#643">643</a> <em>     */</em>
<a name="644" href="#644">644</a>     <strong>public</strong> <strong>void</strong> setType(<a href="../../../../../../org/apache/torque/engine/database/model/SchemaType.html">SchemaType</a> torqueType)
<a name="645" href="#645">645</a>     {
<a name="646" href="#646">646</a>         domain = <strong>new</strong> <a href="../../../../../../org/apache/torque/engine/database/model/Domain.html">Domain</a>(getPlatform().getDomainForSchemaType(torqueType));
<a name="647" href="#647">647</a>         <strong>if</strong> (torqueType.equals(SchemaType.VARBINARY)
<a name="648" href="#648">648</a>                 || torqueType.equals(SchemaType.BLOB))
<a name="649" href="#649">649</a>         {
<a name="650" href="#650">650</a>             needsTransactionInPostgres = <strong>true</strong>;
<a name="651" href="#651">651</a>         }
<a name="652" href="#652">652</a>     }
<a name="653" href="#653">653</a> 
<a name="654" href="#654">654</a>     <em>/**<em>*</em></em>
<a name="655" href="#655">655</a> <em>     * Returns the column jdbc type as an object</em>
<a name="656" href="#656">656</a> <em>     *</em>
<a name="657" href="#657">657</a> <em>     * @deprecated the type conversion is handled by the platform package</em>
<a name="658" href="#658">658</a> <em>     *             (since torque 3.2)</em>
<a name="659" href="#659">659</a> <em>     */</em>
<a name="660" href="#660">660</a>     <strong>public</strong> Object getType()
<a name="661" href="#661">661</a>     {
<a name="662" href="#662">662</a>         <strong>return</strong> TypeMap.getJdbcType(domain.getType()).getName();
<a name="663" href="#663">663</a>     }
<a name="664" href="#664">664</a> 
<a name="665" href="#665">665</a>     <em>/**<em>*</em></em>
<a name="666" href="#666">666</a> <em>     * Returns the column type as given in the schema as an object</em>
<a name="667" href="#667">667</a> <em>     */</em>
<a name="668" href="#668">668</a>     <strong>public</strong> Object getTorqueType()
<a name="669" href="#669">669</a>     {
<a name="670" href="#670">670</a>         <strong>return</strong> domain.getType().getName();
<a name="671" href="#671">671</a>     }
<a name="672" href="#672">672</a> 
<a name="673" href="#673">673</a>     <em>/**<em>*</em></em>
<a name="674" href="#674">674</a> <em>     * Utility method to see if the column is a string</em>
<a name="675" href="#675">675</a> <em>     *</em>
<a name="676" href="#676">676</a> <em>     * @deprecated will be removed after the 3.3 release</em>
<a name="677" href="#677">677</a> <em>     */</em>
<a name="678" href="#678">678</a>     <strong>public</strong> <strong>boolean</strong> isString()
<a name="679" href="#679">679</a>     {
<a name="680" href="#680">680</a>         <strong>return</strong> (domain.getType().getName().indexOf (<span class="string">"CHAR"</span>) != -1);
<a name="681" href="#681">681</a>     }
<a name="682" href="#682">682</a> 
<a name="683" href="#683">683</a>     <em>/**<em>*</em></em>
<a name="684" href="#684">684</a> <em>     * Utility method to return the value as an element to be usable</em>
<a name="685" href="#685">685</a> <em>     * in an SQL insert statement. This is used from the SQL loader task</em>
<a name="686" href="#686">686</a> <em>     */</em>
<a name="687" href="#687">687</a>     <strong>public</strong> <strong>boolean</strong> needEscapedValue()
<a name="688" href="#688">688</a>     {
<a name="689" href="#689">689</a>         String torqueType = domain.getType().getName();
<a name="690" href="#690">690</a>         <strong>return</strong> (torqueType != <strong>null</strong>) &amp;&amp; (torqueType.equals(<span class="string">"VARCHAR"</span>)
<a name="691" href="#691">691</a>                         || torqueType.equals(<span class="string">"LONGVARCHAR"</span>)
<a name="692" href="#692">692</a>                         || torqueType.equals(<span class="string">"DATE"</span>)
<a name="693" href="#693">693</a>                         || torqueType.equals(<span class="string">"DATETIME"</span>)
<a name="694" href="#694">694</a>                         || torqueType.equals(<span class="string">"TIMESTAMP"</span>)
<a name="695" href="#695">695</a>                         || torqueType.equals(<span class="string">"TIME"</span>)
<a name="696" href="#696">696</a>                         || torqueType.equals(<span class="string">"CHAR"</span>)
<a name="697" href="#697">697</a>                         || torqueType.equals(<span class="string">"CLOB"</span>));
<a name="698" href="#698">698</a>     }
<a name="699" href="#699">699</a> 
<a name="700" href="#700">700</a>     <em>/**<em>*</em></em>
<a name="701" href="#701">701</a> <em>     * String representation of the column. This is an xml representation.</em>
<a name="702" href="#702">702</a> <em>     *</em>
<a name="703" href="#703">703</a> <em>     * @return string representation in xml</em>
<a name="704" href="#704">704</a> <em>     */</em>
<a name="705" href="#705">705</a>     <strong>public</strong> String toString()
<a name="706" href="#706">706</a>     {
<a name="707" href="#707">707</a>         StringBuffer result = <strong>new</strong> StringBuffer();
<a name="708" href="#708">708</a>         result.append(<span class="string">"    &lt;column name=\&quot;"</span>).append(name).append('&quot;');
<a name="709" href="#709">709</a> 
<a name="710" href="#710">710</a>         <strong>if</strong> (javaName != <strong>null</strong>)
<a name="711" href="#711">711</a>         {
<a name="712" href="#712">712</a>             result.append(<span class="string">" javaName=\&quot;"</span>).append(javaName).append('&quot;');
<a name="713" href="#713">713</a>         }
<a name="714" href="#714">714</a> 
<a name="715" href="#715">715</a>         <strong>if</strong> (isPrimaryKey)
<a name="716" href="#716">716</a>         {
<a name="717" href="#717">717</a>             result.append(<span class="string">" primaryKey=\&quot;"</span>).append(isPrimaryKey).append('&quot;');
<a name="718" href="#718">718</a>         }
<a name="719" href="#719">719</a> 
<a name="720" href="#720">720</a>         <strong>if</strong> (isNotNull)
<a name="721" href="#721">721</a>         {
<a name="722" href="#722">722</a>             result.append(<span class="string">" required=\&quot;true\&quot;"</span>);
<a name="723" href="#723">723</a>         }
<a name="724" href="#724">724</a>         <strong>else</strong>
<a name="725" href="#725">725</a>         {
<a name="726" href="#726">726</a>             result.append(<span class="string">" required=\&quot;false\&quot;"</span>);
<a name="727" href="#727">727</a>         }
<a name="728" href="#728">728</a> 
<a name="729" href="#729">729</a>         result.append(<span class="string">" type=\&quot;"</span>).append(domain.getType().getName()).append('&quot;');
<a name="730" href="#730">730</a> 
<a name="731" href="#731">731</a>         <strong>if</strong> (domain.getSize() != <strong>null</strong>)
<a name="732" href="#732">732</a>         {
<a name="733" href="#733">733</a>             result.append(<span class="string">" size=\&quot;"</span>).append(domain.getSize()).append('&quot;');
<a name="734" href="#734">734</a>         }
<a name="735" href="#735">735</a> 
<a name="736" href="#736">736</a>         <strong>if</strong> (domain.getScale() != <strong>null</strong>)
<a name="737" href="#737">737</a>         {
<a name="738" href="#738">738</a>             result.append(<span class="string">" scale=\&quot;"</span>).append(domain.getScale()).append('&quot;');
<a name="739" href="#739">739</a>         }
<a name="740" href="#740">740</a> 
<a name="741" href="#741">741</a>         <strong>if</strong> (domain.getDefaultValue() != <strong>null</strong>)
<a name="742" href="#742">742</a>         {
<a name="743" href="#743">743</a>             result.append(<span class="string">" default=\&quot;"</span>).append(domain.getDefaultValue()).append('&quot;');
<a name="744" href="#744">744</a>         }
<a name="745" href="#745">745</a> 
<a name="746" href="#746">746</a>         <strong>if</strong> (isInheritance())
<a name="747" href="#747">747</a>         {
<a name="748" href="#748">748</a>             result.append(<span class="string">" inheritance=\&quot;"</span>).append(inheritanceType)
<a name="749" href="#749">749</a>                 .append('&quot;');
<a name="750" href="#750">750</a>         }
<a name="751" href="#751">751</a> 
<a name="752" href="#752">752</a>         <em class="comment">// Close the column.</em>
<a name="753" href="#753">753</a>         result.append(<span class="string">" />\n"</span>);
<a name="754" href="#754">754</a> 
<a name="755" href="#755">755</a>         <strong>return</strong> result.toString();
<a name="756" href="#756">756</a>     }
<a name="757" href="#757">757</a> 
<a name="758" href="#758">758</a>     <em>/**<em>*</em></em>
<a name="759" href="#759">759</a> <em>     * Returns the size of the column</em>
<a name="760" href="#760">760</a> <em>     */</em>
<a name="761" href="#761">761</a>     <strong>public</strong> String getSize()
<a name="762" href="#762">762</a>     {
<a name="763" href="#763">763</a>         <strong>return</strong> domain.getSize();
<a name="764" href="#764">764</a>     }
<a name="765" href="#765">765</a> 
<a name="766" href="#766">766</a>     <em>/**<em>*</em></em>
<a name="767" href="#767">767</a> <em>     * Set the size of the column</em>
<a name="768" href="#768">768</a> <em>     */</em>
<a name="769" href="#769">769</a>     <strong>public</strong> <strong>void</strong> setSize(String newSize)
<a name="770" href="#770">770</a>     {
<a name="771" href="#771">771</a>         domain.setSize(newSize);
<a name="772" href="#772">772</a>     }
<a name="773" href="#773">773</a> 
<a name="774" href="#774">774</a>     <em>/**<em>*</em></em>
<a name="775" href="#775">775</a> <em>     * Try to determine the precision of the field from the size attribute.</em>
<a name="776" href="#776">776</a> <em>     * If size attribute is an integer number, it will be returned.</em>
<a name="777" href="#777">777</a> <em>     * If size attribute is of the format "Precision,Scale", then Precision</em>
<a name="778" href="#778">778</a> <em>     * will be returned.</em>
<a name="779" href="#779">779</a> <em>     * If size is null or the size value is not an valid integer,</em>
<a name="780" href="#780">780</a> <em>     * null is returned.</em>
<a name="781" href="#781">781</a> <em>     * &lt;p></em>
<a name="782" href="#782">782</a> <em>     * Note: Unparseable values will be logged as a warning.</em>
<a name="783" href="#783">783</a> <em>     *</em>
<a name="784" href="#784">784</a> <em>     * @return The precision portion of the size attribute.</em>
<a name="785" href="#785">785</a> <em>     */</em>
<a name="786" href="#786">786</a>     <strong>public</strong> String getPrecision()
<a name="787" href="#787">787</a>     {
<a name="788" href="#788">788</a>         String size = getSize();
<a name="789" href="#789">789</a>         <strong>if</strong> ( size == <strong>null</strong> )
<a name="790" href="#790">790</a>         {
<a name="791" href="#791">791</a>             <strong>return</strong> size;
<a name="792" href="#792">792</a>         }
<a name="793" href="#793">793</a>         <strong>int</strong> cLoc = size.indexOf(',');
<a name="794" href="#794">794</a>         <strong>if</strong> ( cLoc > 0 )
<a name="795" href="#795">795</a>         {
<a name="796" href="#796">796</a>             size = size.substring(0, cLoc);
<a name="797" href="#797">797</a>         }
<a name="798" href="#798">798</a>         <strong>try</strong>
<a name="799" href="#799">799</a>         {
<a name="800" href="#800">800</a>             Integer.parseInt(size);
<a name="801" href="#801">801</a>         }
<a name="802" href="#802">802</a>         <strong>catch</strong> ( NumberFormatException e  )
<a name="803" href="#803">803</a>         {
<a name="804" href="#804">804</a>             log.warn(<span class="string">"getPrecision(): Size attribute found ("</span>
<a name="805" href="#805">805</a>                     + getSize()
<a name="806" href="#806">806</a>                     + <span class="string">") was not an integer number, using default of null!"</span>);
<a name="807" href="#807">807</a>             size = <strong>null</strong>;
<a name="808" href="#808">808</a>         }
<a name="809" href="#809">809</a>         <strong>return</strong> size;
<a name="810" href="#810">810</a>     }
<a name="811" href="#811">811</a> 
<a name="812" href="#812">812</a>     <em>/**<em>*</em></em>
<a name="813" href="#813">813</a> <em>     * Try to determine the scale of the field from the scale and size</em>
<a name="814" href="#814">814</a> <em>     * attribute.</em>
<a name="815" href="#815">815</a> <em>     * If scale attribute is an integer number, it will be returned.</em>
<a name="816" href="#816">816</a> <em>     * If size attribute is of the format "Precision,Scale", then Scale</em>
<a name="817" href="#817">817</a> <em>     * will be returned.</em>
<a name="818" href="#818">818</a> <em>     * If scale and size attributes are null or the scale value found</em>
<a name="819" href="#819">819</a> <em>     * is not an valid integer, a null value is returned.</em>
<a name="820" href="#820">820</a> <em>     * &lt;p></em>
<a name="821" href="#821">821</a> <em>     * Note: Unparseable values will be logged as a warning.</em>
<a name="822" href="#822">822</a> <em>     *</em>
<a name="823" href="#823">823</a> <em>     * @return The precision portion of the size attribute.</em>
<a name="824" href="#824">824</a> <em>     */</em>
<a name="825" href="#825">825</a>     <strong>public</strong> String getScale()
<a name="826" href="#826">826</a>     {
<a name="827" href="#827">827</a>         String scale = domain.getScale();
<a name="828" href="#828">828</a>         <em class="comment">// Check for scale on size attribute if no scale attribute</em>
<a name="829" href="#829">829</a>         <strong>if</strong> ( scale == <strong>null</strong> )
<a name="830" href="#830">830</a>         {
<a name="831" href="#831">831</a>             scale = getSize();
<a name="832" href="#832">832</a>             <strong>if</strong> ( scale == <strong>null</strong> )   <em class="comment">// No scale or size attribute set.</em>
<a name="833" href="#833">833</a>             {
<a name="834" href="#834">834</a>                 <strong>return</strong> scale;
<a name="835" href="#835">835</a>             }
<a name="836" href="#836">836</a>             <strong>int</strong> cLoc = scale.indexOf(',');
<a name="837" href="#837">837</a>             <strong>if</strong> ( cLoc &lt; 0 )        <em class="comment">// Size did not have "P,S" format</em>
<a name="838" href="#838">838</a>             {
<a name="839" href="#839">839</a>                 <strong>return</strong> <strong>null</strong>;
<a name="840" href="#840">840</a>             }
<a name="841" href="#841">841</a>             scale = scale.substring(cLoc + 1 );
<a name="842" href="#842">842</a>         }
<a name="843" href="#843">843</a> 
<a name="844" href="#844">844</a>         <em class="comment">// Validate that scale string found is integer.</em>
<a name="845" href="#845">845</a>         <strong>try</strong>
<a name="846" href="#846">846</a>         {
<a name="847" href="#847">847</a>             Integer.parseInt(scale);
<a name="848" href="#848">848</a>         }
<a name="849" href="#849">849</a>         <strong>catch</strong> ( NumberFormatException e  )
<a name="850" href="#850">850</a>         {
<a name="851" href="#851">851</a>             log.warn(<span class="string">"getScale(): Scale (or size=\&quot;p,s\&quot;) attribute found ("</span>
<a name="852" href="#852">852</a>                     + scale
<a name="853" href="#853">853</a>                     + <span class="string">") was not an integer number, using default of null."</span>);
<a name="854" href="#854">854</a>             scale = <strong>null</strong>;
<a name="855" href="#855">855</a>         }
<a name="856" href="#856">856</a>         <strong>return</strong> scale;
<a name="857" href="#857">857</a>     }
<a name="858" href="#858">858</a> 
<a name="859" href="#859">859</a>     <em>/**<em>*</em></em>
<a name="860" href="#860">860</a> <em>     * Set the scale of the column</em>
<a name="861" href="#861">861</a> <em>     */</em>
<a name="862" href="#862">862</a>     <strong>public</strong> <strong>void</strong> setScale(String newScale)
<a name="863" href="#863">863</a>     {
<a name="864" href="#864">864</a>         domain.setScale(newScale);
<a name="865" href="#865">865</a>     }
<a name="866" href="#866">866</a> 
<a name="867" href="#867">867</a>     <em>/**<em>*</em></em>
<a name="868" href="#868">868</a> <em>     * Return the size and scale in brackets for use in an sql schema.</em>
<a name="869" href="#869">869</a> <em>     *</em>
<a name="870" href="#870">870</a> <em>     * @return size and scale or an empty String if there are no values</em>
<a name="871" href="#871">871</a> <em>     *         available.</em>
<a name="872" href="#872">872</a> <em>     */</em>
<a name="873" href="#873">873</a>     <strong>public</strong> String printSize()
<a name="874" href="#874">874</a>     {
<a name="875" href="#875">875</a>         <strong>return</strong> domain.printSize();
<a name="876" href="#876">876</a>     }
<a name="877" href="#877">877</a> 
<a name="878" href="#878">878</a>     <em>/**<em>*</em></em>
<a name="879" href="#879">879</a> <em>     * Return a string that will give this column a default value.</em>
<a name="880" href="#880">880</a> <em>     * @deprecated</em>
<a name="881" href="#881">881</a> <em>     */</em>
<a name="882" href="#882">882</a>      <strong>public</strong> String getDefaultSetting()
<a name="883" href="#883">883</a>      {
<a name="884" href="#884">884</a>          <strong>return</strong> domain.getDefaultSetting();
<a name="885" href="#885">885</a>      }
<a name="886" href="#886">886</a> 
<a name="887" href="#887">887</a>     <em>/**<em>*</em></em>
<a name="888" href="#888">888</a> <em>     * Set a string that will give this column a default value.</em>
<a name="889" href="#889">889</a> <em>     */</em>
<a name="890" href="#890">890</a>     <strong>public</strong> <strong>void</strong> setDefaultValue(String def)
<a name="891" href="#891">891</a>     {
<a name="892" href="#892">892</a>         domain.setDefaultValue(def);
<a name="893" href="#893">893</a>     }
<a name="894" href="#894">894</a> 
<a name="895" href="#895">895</a>     <em>/**<em>*</em></em>
<a name="896" href="#896">896</a> <em>     * Get a string that will give this column a default value.</em>
<a name="897" href="#897">897</a> <em>     */</em>
<a name="898" href="#898">898</a>     <strong>public</strong> String getDefaultValue()
<a name="899" href="#899">899</a>     {
<a name="900" href="#900">900</a>         <strong>return</strong> domain.getDefaultValue();
<a name="901" href="#901">901</a>     }
<a name="902" href="#902">902</a> 
<a name="903" href="#903">903</a>     <em>/**<em>*</em></em>
<a name="904" href="#904">904</a> <em>     * Returns the class name to do input validation</em>
<a name="905" href="#905">905</a> <em>     */</em>
<a name="906" href="#906">906</a>     <strong>public</strong> String getInputValidator()
<a name="907" href="#907">907</a>     {
<a name="908" href="#908">908</a>        <strong>return</strong> <strong>this</strong>.inputValidator;
<a name="909" href="#909">909</a>     }
<a name="910" href="#910">910</a> 
<a name="911" href="#911">911</a>     <em>/**<em>*</em></em>
<a name="912" href="#912">912</a> <em>     * Return auto increment/sequence string for the target database. We need to</em>
<a name="913" href="#913">913</a> <em>     * pass in the props for the target database!</em>
<a name="914" href="#914">914</a> <em>     */</em>
<a name="915" href="#915">915</a>     <strong>public</strong> <strong>boolean</strong> isAutoIncrement()
<a name="916" href="#916">916</a>     {
<a name="917" href="#917">917</a>         <strong>return</strong> isAutoIncrement;
<a name="918" href="#918">918</a>     }
<a name="919" href="#919">919</a> 
<a name="920" href="#920">920</a>     <em>/**<em>*</em></em>
<a name="921" href="#921">921</a> <em>     * Set the auto increment value.</em>
<a name="922" href="#922">922</a> <em>     * Use isAutoIncrement() to find out if it is set or not.</em>
<a name="923" href="#923">923</a> <em>     */</em>
<a name="924" href="#924">924</a>     <strong>public</strong> <strong>void</strong> setAutoIncrement(<strong>boolean</strong> value)
<a name="925" href="#925">925</a>     {
<a name="926" href="#926">926</a>         isAutoIncrement = value;
<a name="927" href="#927">927</a>     }
<a name="928" href="#928">928</a> 
<a name="929" href="#929">929</a>     <strong>public</strong> String getAutoIncrementString()
<a name="930" href="#930">930</a>     {
<a name="931" href="#931">931</a>         <strong>if</strong> (isAutoIncrement()
<a name="932" href="#932">932</a>                 &amp;&amp; IDMethod.NATIVE.equals(getTable().getIdMethod()))
<a name="933" href="#933">933</a>         {
<a name="934" href="#934">934</a>             <strong>return</strong> getPlatform().getAutoIncrement();
<a name="935" href="#935">935</a>         }
<a name="936" href="#936">936</a>         <strong>return</strong> <span class="string">""</span>;
<a name="937" href="#937">937</a>     }
<a name="938" href="#938">938</a> 
<a name="939" href="#939">939</a>     <em>/**<em>*</em></em>
<a name="940" href="#940">940</a> <em>     * Set the column type from a string property</em>
<a name="941" href="#941">941</a> <em>     * (normally a string from an sql input file)</em>
<a name="942" href="#942">942</a> <em>     */</em>
<a name="943" href="#943">943</a>     <strong>public</strong> <strong>void</strong> setTypeFromString(String typeName, String size)
<a name="944" href="#944">944</a>     {
<a name="945" href="#945">945</a>         String tn = typeName.toUpperCase();
<a name="946" href="#946">946</a>         setType(tn);
<a name="947" href="#947">947</a> 
<a name="948" href="#948">948</a>         <strong>if</strong> (size != <strong>null</strong>)
<a name="949" href="#949">949</a>         {
<a name="950" href="#950">950</a>             domain.setSize(size);
<a name="951" href="#951">951</a>         }
<a name="952" href="#952">952</a> 
<a name="953" href="#953">953</a>         <strong>if</strong> (tn.indexOf(<span class="string">"CHAR"</span>) != -1)
<a name="954" href="#954">954</a>         {
<a name="955" href="#955">955</a>             domain.setType(SchemaType.VARCHAR);
<a name="956" href="#956">956</a>         }
<a name="957" href="#957">957</a>         <strong>else</strong> <strong>if</strong> (tn.indexOf(<span class="string">"INT"</span>) != -1)
<a name="958" href="#958">958</a>         {
<a name="959" href="#959">959</a>             domain.setType(SchemaType.INTEGER);
<a name="960" href="#960">960</a>         }
<a name="961" href="#961">961</a>         <strong>else</strong> <strong>if</strong> (tn.indexOf(<span class="string">"FLOAT"</span>) != -1)
<a name="962" href="#962">962</a>         {
<a name="963" href="#963">963</a>             domain.setType(SchemaType.FLOAT);
<a name="964" href="#964">964</a>         }
<a name="965" href="#965">965</a>         <strong>else</strong> <strong>if</strong> (tn.indexOf(<span class="string">"DATE"</span>) != -1)
<a name="966" href="#966">966</a>         {
<a name="967" href="#967">967</a>             domain.setType(SchemaType.DATE);
<a name="968" href="#968">968</a>         }
<a name="969" href="#969">969</a>         <strong>else</strong> <strong>if</strong> (tn.indexOf(<span class="string">"TIME"</span>) != -1)
<a name="970" href="#970">970</a>         {
<a name="971" href="#971">971</a>             domain.setType(SchemaType.TIMESTAMP);
<a name="972" href="#972">972</a>         }
<a name="973" href="#973">973</a>         <strong>else</strong> <strong>if</strong> (tn.indexOf(<span class="string">"BINARY"</span>) != -1)
<a name="974" href="#974">974</a>         {
<a name="975" href="#975">975</a>             domain.setType(SchemaType.LONGVARBINARY);
<a name="976" href="#976">976</a>         }
<a name="977" href="#977">977</a>         <strong>else</strong>
<a name="978" href="#978">978</a>         {
<a name="979" href="#979">979</a>             domain.setType(SchemaType.VARCHAR);
<a name="980" href="#980">980</a>         }
<a name="981" href="#981">981</a>     }
<a name="982" href="#982">982</a> 
<a name="983" href="#983">983</a>     <em>/**<em>*</em></em>
<a name="984" href="#984">984</a> <em>     * Return a string representation of the</em>
<a name="985" href="#985">985</a> <em>     * Java object which corresponds to the JDBC</em>
<a name="986" href="#986">986</a> <em>     * type of this column. Use in the generation</em>
<a name="987" href="#987">987</a> <em>     * of MapBuilders.</em>
<a name="988" href="#988">988</a> <em>     */</em>
<a name="989" href="#989">989</a>     <strong>public</strong> String getJavaObject()
<a name="990" href="#990">990</a>     {
<a name="991" href="#991">991</a>         <strong>return</strong> TypeMap.getJavaObject(domain.getType());
<a name="992" href="#992">992</a>     }
<a name="993" href="#993">993</a> 
<a name="994" href="#994">994</a>     <em>/**<em>*</em></em>
<a name="995" href="#995">995</a> <em>     * Return a string representation of the primitive java type which</em>
<a name="996" href="#996">996</a> <em>     * corresponds to the JDBC type of this column.</em>
<a name="997" href="#997">997</a> <em>     *</em>
<a name="998" href="#998">998</a> <em>     * @return string representation of the primitive java type</em>
<a name="999" href="#999">999</a> <em>     */</em>
<a name="1000" href="#1000">1000</a>     <strong>public</strong> String getJavaPrimitive()
<a name="1001" href="#1001">1001</a>     {
<a name="1002" href="#1002">1002</a>         <strong>return</strong> TypeMap.getJavaNative(domain.getType());
<a name="1003" href="#1003">1003</a>     }
<a name="1004" href="#1004">1004</a> 
<a name="1005" href="#1005">1005</a>     <em>/**<em>*</em></em>
<a name="1006" href="#1006">1006</a> <em>     * Return a string representation of the native java type which corresponds</em>
<a name="1007" href="#1007">1007</a> <em>     * to the JDBC type of this column. Use in the generation of Base objects.</em>
<a name="1008" href="#1008">1008</a> <em>     * This method is used by torque, so it returns Key types for primaryKey and</em>
<a name="1009" href="#1009">1009</a> <em>     * foreignKey columns</em>
<a name="1010" href="#1010">1010</a> <em>     *</em>
<a name="1011" href="#1011">1011</a> <em>     * @return java datatype used by torque</em>
<a name="1012" href="#1012">1012</a> <em>     */</em>
<a name="1013" href="#1013">1013</a>     <strong>public</strong> String getJavaNative()
<a name="1014" href="#1014">1014</a>     {
<a name="1015" href="#1015">1015</a>         String jtype = TypeMap.getJavaNativeObject(domain.getType());
<a name="1016" href="#1016">1016</a>         <strong>if</strong> (isUsePrimitive())
<a name="1017" href="#1017">1017</a>         {
<a name="1018" href="#1018">1018</a>             jtype = TypeMap.getJavaNative(domain.getType());
<a name="1019" href="#1019">1019</a>         }
<a name="1020" href="#1020">1020</a> 
<a name="1021" href="#1021">1021</a>         <strong>return</strong> jtype;
<a name="1022" href="#1022">1022</a>     }
<a name="1023" href="#1023">1023</a> 
<a name="1024" href="#1024">1024</a>     <em>/**<em>*</em></em>
<a name="1025" href="#1025">1025</a> <em>     * Return Village asX() method which corresponds to the JDBC type</em>
<a name="1026" href="#1026">1026</a> <em>     * which represents this column.</em>
<a name="1027" href="#1027">1027</a> <em>     */</em>
<a name="1028" href="#1028">1028</a>     <strong>public</strong> String getVillageMethod()
<a name="1029" href="#1029">1029</a>     {
<a name="1030" href="#1030">1030</a>         String vmethod = TypeMap.getVillageObjectMethod(domain.getType());
<a name="1031" href="#1031">1031</a>         <strong>if</strong> (isUsePrimitive())
<a name="1032" href="#1032">1032</a>         {
<a name="1033" href="#1033">1033</a>             vmethod = TypeMap.getVillageMethod(domain.getType());
<a name="1034" href="#1034">1034</a>         }
<a name="1035" href="#1035">1035</a> 
<a name="1036" href="#1036">1036</a>         <strong>return</strong> vmethod;
<a name="1037" href="#1037">1037</a>     }
<a name="1038" href="#1038">1038</a> 
<a name="1039" href="#1039">1039</a>     <em>/**<em>*</em></em>
<a name="1040" href="#1040">1040</a> <em>     * Return ParameterParser getX() method which</em>
<a name="1041" href="#1041">1041</a> <em>     * corresponds to the JDBC type which represents this column.</em>
<a name="1042" href="#1042">1042</a> <em>     */</em>
<a name="1043" href="#1043">1043</a>     <strong>public</strong> String getParameterParserMethod()
<a name="1044" href="#1044">1044</a>     {
<a name="1045" href="#1045">1045</a>         <strong>return</strong> TypeMap.getPPMethod(domain.getType());
<a name="1046" href="#1046">1046</a>     }
<a name="1047" href="#1047">1047</a> 
<a name="1048" href="#1048">1048</a>     <em>/**<em>*</em></em>
<a name="1049" href="#1049">1049</a> <em>     * Returns true if the column type is boolean in the</em>
<a name="1050" href="#1050">1050</a> <em>     * java object and a numeric (1 or 0) in the db.</em>
<a name="1051" href="#1051">1051</a> <em>     */</em>
<a name="1052" href="#1052">1052</a>     <strong>public</strong> <strong>boolean</strong> isBooleanInt()
<a name="1053" href="#1053">1053</a>     {
<a name="1054" href="#1054">1054</a>         <strong>return</strong> TypeMap.isBooleanInt(domain.getType());
<a name="1055" href="#1055">1055</a>     }
<a name="1056" href="#1056">1056</a> 
<a name="1057" href="#1057">1057</a>     <em>/**<em>*</em></em>
<a name="1058" href="#1058">1058</a> <em>     * Returns true if the column type is boolean in the</em>
<a name="1059" href="#1059">1059</a> <em>     * java object and a String ("Y" or "N") in the db.</em>
<a name="1060" href="#1060">1060</a> <em>     */</em>
<a name="1061" href="#1061">1061</a>     <strong>public</strong> <strong>boolean</strong> isBooleanChar()
<a name="1062" href="#1062">1062</a>     {
<a name="1063" href="#1063">1063</a>         <strong>return</strong> TypeMap.isBooleanChar(domain.getType());
<a name="1064" href="#1064">1064</a>     }
<a name="1065" href="#1065">1065</a> 
<a name="1066" href="#1066">1066</a>     <em>/**<em>*</em></em>
<a name="1067" href="#1067">1067</a> <em>     * Returns true if the column type is boolean in the</em>
<a name="1068" href="#1068">1068</a> <em>     * java object and a Bit ("1" or "0") in the db.</em>
<a name="1069" href="#1069">1069</a> <em>     */</em>
<a name="1070" href="#1070">1070</a>     <strong>public</strong> <strong>boolean</strong> isBit()
<a name="1071" href="#1071">1071</a>     {
<a name="1072" href="#1072">1072</a>         <strong>return</strong> TypeMap.isBit(domain.getType());
<a name="1073" href="#1073">1073</a>     }
<a name="1074" href="#1074">1074</a> 
<a name="1075" href="#1075">1075</a>     <em>/**<em>*</em></em>
<a name="1076" href="#1076">1076</a> <em>     * returns true, if the columns java native type is an</em>
<a name="1077" href="#1077">1077</a> <em>     * boolean, byte, short, int, long, float, double, char</em>
<a name="1078" href="#1078">1078</a> <em>     */</em>
<a name="1079" href="#1079">1079</a>     <strong>public</strong> <strong>boolean</strong> isPrimitive()
<a name="1080" href="#1080">1080</a>     {
<a name="1081" href="#1081">1081</a>         String t = getJavaNative();
<a name="1082" href="#1082">1082</a>         <strong>return</strong> <span class="string">"boolean"</span>.equals(t)
<a name="1083" href="#1083">1083</a>             || <span class="string">"byte"</span>.equals(t)
<a name="1084" href="#1084">1084</a>             || <span class="string">"short"</span>.equals(t)
<a name="1085" href="#1085">1085</a>             || <span class="string">"int"</span>.equals(t)
<a name="1086" href="#1086">1086</a>             || <span class="string">"long"</span>.equals(t)
<a name="1087" href="#1087">1087</a>             || <span class="string">"float"</span>.equals(t)
<a name="1088" href="#1088">1088</a>             || <span class="string">"double"</span>.equals(t)
<a name="1089" href="#1089">1089</a>             || <span class="string">"char"</span>.equals(t);
<a name="1090" href="#1090">1090</a>     }
<a name="1091" href="#1091">1091</a> 
<a name="1092" href="#1092">1092</a>     <strong>public</strong> <strong>boolean</strong> isUsePrimitive()
<a name="1093" href="#1093">1093</a>     {
<a name="1094" href="#1094">1094</a>         String s = getJavaType();
<a name="1095" href="#1095">1095</a>         <strong>return</strong> (s != <strong>null</strong> &amp;&amp; s.equals(<span class="string">"primitive"</span>))
<a name="1096" href="#1096">1096</a>             || (s == <strong>null</strong> &amp;&amp; !<span class="string">"object"</span>.equals(
<a name="1097" href="#1097">1097</a>                getTable().getDatabase().getDefaultJavaType()));
<a name="1098" href="#1098">1098</a>     }
<a name="1099" href="#1099">1099</a> 
<a name="1100" href="#1100">1100</a>     <em>/**<em>*</em></em>
<a name="1101" href="#1101">1101</a> <em>     * @return Returns the domain.</em>
<a name="1102" href="#1102">1102</a> <em>     */</em>
<a name="1103" href="#1103">1103</a>     <strong>public</strong> <a href="../../../../../../org/apache/torque/engine/database/model/Domain.html">Domain</a> getDomain()
<a name="1104" href="#1104">1104</a>     {
<a name="1105" href="#1105">1105</a>         <strong>return</strong> domain;
<a name="1106" href="#1106">1106</a>     }
<a name="1107" href="#1107">1107</a> 
<a name="1108" href="#1108">1108</a>     <em>/**<em>*</em></em>
<a name="1109" href="#1109">1109</a> <em>     * @param domain The domain to set.</em>
<a name="1110" href="#1110">1110</a> <em>     */</em>
<a name="1111" href="#1111">1111</a>     <strong>public</strong> <strong>void</strong> setDomain(<a href="../../../../../../org/apache/torque/engine/database/model/Domain.html">Domain</a> domain)
<a name="1112" href="#1112">1112</a>     {
<a name="1113" href="#1113">1113</a>         <strong>this</strong>.domain = domain;
<a name="1114" href="#1114">1114</a>     }
<a name="1115" href="#1115">1115</a> 
<a name="1116" href="#1116">1116</a>     <strong>private</strong> <a href="../../../../../../org/apache/torque/engine/platform/Platform.html">Platform</a> getPlatform()
<a name="1117" href="#1117">1117</a>     {
<a name="1118" href="#1118">1118</a>         <strong>try</strong>
<a name="1119" href="#1119">1119</a>         {
<a name="1120" href="#1120">1120</a>             <strong>return</strong> getTable().getDatabase().getPlatform();
<a name="1121" href="#1121">1121</a>         }
<a name="1122" href="#1122">1122</a>         <strong>catch</strong> (Exception ex)
<a name="1123" href="#1123">1123</a>         {
<a name="1124" href="#1124">1124</a>             log.warn(<span class="string">"could not load platform implementation"</span>);
<a name="1125" href="#1125">1125</a>         }
<a name="1126" href="#1126">1126</a>         <strong>return</strong> <strong>new</strong> <a href="../../../../../../org/apache/torque/engine/platform/PlatformDefaultImpl.html">PlatformDefaultImpl</a>();
<a name="1127" href="#1127">1127</a>     }
<a name="1128" href="#1128">1128</a> 
<a name="1129" href="#1129">1129</a>     <strong>public</strong> String getSqlString()
<a name="1130" href="#1130">1130</a>     {
<a name="1131" href="#1131">1131</a>         List resultList = <strong>new</strong> ArrayList();
<a name="1132" href="#1132">1132</a>         resultList.add(getName());
<a name="1133" href="#1133">1133</a> 
<a name="1134" href="#1134">1134</a>         String type = getDomain().getSqlType();
<a name="1135" href="#1135">1135</a> 
<a name="1136" href="#1136">1136</a>         <strong>if</strong> (getPlatform().hasSize(getDomain().getSqlType()))
<a name="1137" href="#1137">1137</a>         {
<a name="1138" href="#1138">1138</a>             type += getDomain().printSize();
<a name="1139" href="#1139">1139</a>         }
<a name="1140" href="#1140">1140</a> 
<a name="1141" href="#1141">1141</a>         resultList.add(type);
<a name="1142" href="#1142">1142</a> 
<a name="1143" href="#1143">1143</a>         <strong>if</strong> (StringUtils.isNotEmpty(getDomain().getDefaultValue()))
<a name="1144" href="#1144">1144</a>         {
<a name="1145" href="#1145">1145</a>             resultList.add(<span class="string">"default"</span>);
<a name="1146" href="#1146">1146</a> 
<a name="1147" href="#1147">1147</a>             <strong>if</strong> (TypeMap.isTextType(getDomain().getType()))
<a name="1148" href="#1148">1148</a>             {
<a name="1149" href="#1149">1149</a>                 <em class="comment">// TODO: Properly SQL-escape the text.</em>
<a name="1150" href="#1150">1150</a>                 resultList.add(
<a name="1151" href="#1151">1151</a>                         <strong>new</strong> StringBuffer()
<a name="1152" href="#1152">1152</a>                         .append('\'')
<a name="1153" href="#1153">1153</a>                         .append(getDefaultValue())
<a name="1154" href="#1154">1154</a>                         .append('\''));
<a name="1155" href="#1155">1155</a>             }
<a name="1156" href="#1156">1156</a>             <strong>else</strong>
<a name="1157" href="#1157">1157</a>             {
<a name="1158" href="#1158">1158</a>                 resultList.add(getDefaultValue());
<a name="1159" href="#1159">1159</a>             }
<a name="1160" href="#1160">1160</a>         }
<a name="1161" href="#1161">1161</a>         <strong>if</strong> (getPlatform().createNotNullBeforeAutoincrement())
<a name="1162" href="#1162">1162</a>         {
<a name="1163" href="#1163">1163</a>             <strong>if</strong> (StringUtils.isNotEmpty(getNotNullString()))
<a name="1164" href="#1164">1164</a>             {
<a name="1165" href="#1165">1165</a>                 resultList.add(getNotNullString());
<a name="1166" href="#1166">1166</a>             }
<a name="1167" href="#1167">1167</a>         }
<a name="1168" href="#1168">1168</a>         <strong>if</strong> (StringUtils.isNotEmpty(getAutoIncrementString()))
<a name="1169" href="#1169">1169</a>         {
<a name="1170" href="#1170">1170</a>             resultList.add(getAutoIncrementString());
<a name="1171" href="#1171">1171</a>         }
<a name="1172" href="#1172">1172</a>         <strong>if</strong> (!getPlatform().createNotNullBeforeAutoincrement())
<a name="1173" href="#1173">1173</a>         {
<a name="1174" href="#1174">1174</a>             <strong>if</strong> (StringUtils.isNotEmpty(getNotNullString()))
<a name="1175" href="#1175">1175</a>             {
<a name="1176" href="#1176">1176</a>                 resultList.add(getNotNullString());
<a name="1177" href="#1177">1177</a>             }
<a name="1178" href="#1178">1178</a>         }
<a name="1179" href="#1179">1179</a>         <strong>return</strong> StringUtils.join(resultList.iterator(), ' ');
<a name="1180" href="#1180">1180</a>     }
<a name="1181" href="#1181">1181</a> 
<a name="1182" href="#1182">1182</a>     <em>/**<em>*</em></em>
<a name="1183" href="#1183">1183</a> <em>     * Return the correctGetters property of the column</em>
<a name="1184" href="#1184">1184</a> <em>     *</em>
<a name="1185" href="#1185">1185</a> <em>     * @return The currentValue of the correctGetters property.</em>
<a name="1186" href="#1186">1186</a> <em>     * @since 3.2</em>
<a name="1187" href="#1187">1187</a> <em>     */</em>
<a name="1188" href="#1188">1188</a>     <strong>public</strong> <strong>boolean</strong> isCorrectGetters()
<a name="1189" href="#1189">1189</a>     {
<a name="1190" href="#1190">1190</a>         <strong>return</strong> correctGetters;
<a name="1191" href="#1191">1191</a>     }
<a name="1192" href="#1192">1192</a> 
<a name="1193" href="#1193">1193</a>     <em>/**<em>*</em></em>
<a name="1194" href="#1194">1194</a> <em>     * Set the correctGetters property of the column. If set to true, the</em>
<a name="1195" href="#1195">1195</a> <em>     * column returns is&amp;lt;xxx&amp;gt; as the getter name which is correct for the</em>
<a name="1196" href="#1196">1196</a> <em>     * Bean Specs but incompatible to pre-3.2 releases.</em>
<a name="1197" href="#1197">1197</a> <em>     *</em>
<a name="1198" href="#1198">1198</a> <em>     * @param correctGetters The new value of the correctGetters property.</em>
<a name="1199" href="#1199">1199</a> <em>     * @since 3.2</em>
<a name="1200" href="#1200">1200</a> <em>     */</em>
<a name="1201" href="#1201">1201</a>     <strong>public</strong> <strong>void</strong> setCorrectGetters(<strong>boolean</strong> correctGetters)
<a name="1202" href="#1202">1202</a>     {
<a name="1203" href="#1203">1203</a>         <strong>this</strong>.correctGetters = correctGetters;
<a name="1204" href="#1204">1204</a>     }
<a name="1205" href="#1205">1205</a> 
<a name="1206" href="#1206">1206</a>     <em>/**<em>*</em></em>
<a name="1207" href="#1207">1207</a> <em>     * Get the value of the inheritance attribute defined in the schema XML.</em>
<a name="1208" href="#1208">1208</a> <em>     *</em>
<a name="1209" href="#1209">1209</a> <em>     * @return Returns the inheritanceType.</em>
<a name="1210" href="#1210">1210</a> <em>     */</em>
<a name="1211" href="#1211">1211</a>     <strong>public</strong> String getInheritanceType()
<a name="1212" href="#1212">1212</a>     {
<a name="1213" href="#1213">1213</a>         <strong>return</strong> inheritanceType;
<a name="1214" href="#1214">1214</a>     }
<a name="1215" href="#1215">1215</a> 
<a name="1216" href="#1216">1216</a>     <em>/**<em>*</em></em>
<a name="1217" href="#1217">1217</a> <em>     * Add an XML Specified option key/value pair to this element's option set.</em>
<a name="1218" href="#1218">1218</a> <em>     *</em>
<a name="1219" href="#1219">1219</a> <em>     * @param key the key of the option.</em>
<a name="1220" href="#1220">1220</a> <em>     * @param value the value of the option.</em>
<a name="1221" href="#1221">1221</a> <em>     */</em>
<a name="1222" href="#1222">1222</a>     <strong>public</strong> <strong>void</strong> addOption(String key, String value)
<a name="1223" href="#1223">1223</a>     {
<a name="1224" href="#1224">1224</a>         options.put( key, value );
<a name="1225" href="#1225">1225</a>     }
<a name="1226" href="#1226">1226</a> 
<a name="1227" href="#1227">1227</a>     <em>/**<em>*</em></em>
<a name="1228" href="#1228">1228</a> <em>     * Get the value that was associated with this key in an XML option</em>
<a name="1229" href="#1229">1229</a> <em>     * element.</em>
<a name="1230" href="#1230">1230</a> <em>     *</em>
<a name="1231" href="#1231">1231</a> <em>     * @param key the key of the option.</em>
<a name="1232" href="#1232">1232</a> <em>     * @return The value for the key or a null.</em>
<a name="1233" href="#1233">1233</a> <em>     */</em>
<a name="1234" href="#1234">1234</a>     <strong>public</strong> String getOption(String key)
<a name="1235" href="#1235">1235</a>     {
<a name="1236" href="#1236">1236</a>         <strong>return</strong> (String) options.get(key);
<a name="1237" href="#1237">1237</a>     }
<a name="1238" href="#1238">1238</a> 
<a name="1239" href="#1239">1239</a>     <em>/**<em>*</em></em>
<a name="1240" href="#1240">1240</a> <em>     * Gets the full ordered hashtable array of items specified by XML option</em>
<a name="1241" href="#1241">1241</a> <em>     * statements under this element.&lt;p></em>
<a name="1242" href="#1242">1242</a> <em>     *</em>
<a name="1243" href="#1243">1243</a> <em>     * Note, this is not thread save but since it's only used for</em>
<a name="1244" href="#1244">1244</a> <em>     * generation which is single threaded, there should be minimum</em>
<a name="1245" href="#1245">1245</a> <em>     * danger using this in Velocity.</em>
<a name="1246" href="#1246">1246</a> <em>     *</em>
<a name="1247" href="#1247">1247</a> <em>     * @return An Map of all options. Will not be null but may be empty.</em>
<a name="1248" href="#1248">1248</a> <em>     */</em>
<a name="1249" href="#1249">1249</a>     <strong>public</strong> Map getOptions()
<a name="1250" href="#1250">1250</a>     {
<a name="1251" href="#1251">1251</a>         <strong>return</strong> options;
<a name="1252" href="#1252">1252</a>     }
<a name="1253" href="#1253">1253</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

